<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>STK Opcodes</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="PartOpcodesOverview.html" title="Part II. Opcodes Overview" />
    <link rel="prev" href="ImageopcodesTop.html" title="Image processing opcodes" />
    <link rel="next" href="MiscopcodesTop.html" title="Miscellaneous opcodes" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">STK Opcodes</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="ImageopcodesTop.html">Prev</a> </td>
          <th width="60%" align="center">Part II. Opcodes Overview</th>
          <td width="20%" align="right"> <a accesskey="n" href="MiscopcodesTop.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="chapter">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title"><a id="STKTop"></a>STK Opcodes</h2>
          </div>
        </div>
      </div>
      <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
        <table border="0" summary="Note">
          <tr>
            <td rowspan="2" align="center" valign="top" width="25">
              <img alt="[Note]" src="images/note.png" />
            </td>
            <th align="left">Note</th>
          </tr>
          <tr>
            <td align="left" valign="top">
              <p>
      These opcodes are an optional component of Csound5. You can check if
      they are installed by using the command 'csound -z' which lists all
      available opcodes.
    </p>
            </td>
          </tr>
        </table>
      </div>
      <p>
    The STK opcodes can be built in several ways. If you are already building
    Csound, simply follow the directions at the top of the Opcodes/stk/stkOpcodes.cpp
    file.
  </p>
      <p>
    If you do not wish to build all of Csound, you can still build the STK
    opcodes as an opcode plugin (shared library). You can adapt the example from
    the Csound GIT repository in the pluginSDK directory. Replace the
    pluginSDK/examplePlugin.c file with the opcodes/stk/stkOpcodes.cpp file, and
    change the name of this file in the SConstruct build file. Then use scons to
    build the opcodes. Be sure to use the scons command-line option useDouble=0
    if you have single-precision (32 bit) Csound, and useDouble=1 if you have
    double-precision (64 bit) Csound.
  </p>
      <p>
    You must also either add all the STK source code files and include path to
    the SConstruct file, or you must add a prebuilt STK library and include path
    to the SConstruct file. The STK source files would go near line 296 in the
    SConstruct file:

</p>
      <pre class="programlisting">makePlugin(pluginEnvironment, 'stkOpcodes', Split('''
    stkOpcodes.cpp
    ... STK source files ...
'''))</pre>
      <p>
  </p>
      <p>The STK family of opcodes wraps:
    </p>
      <div class="itemizedlist">
        <ul class="itemizedlist" style="list-style-type: disc; ">
          <li class="listitem">
            <a class="link" href="STKBandedWG.html" title="STKBandedWG">
              <em class="citetitle">STKBandedWG</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKBeeThree.html" title="STKBeeThree">
              <em class="citetitle">STKBeeThree</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKBlowBotl.html" title="STKBlowBotl">
              <em class="citetitle">STKBlowBotl</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKBlowHole.html" title="STKBlowHole">
              <em class="citetitle">STKBlowHole</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKBowed.html" title="STKBowed">
              <em class="citetitle">STKBowed</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKBrass.html" title="STKBrass">
              <em class="citetitle">STKBrass</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKClarinet.html" title="STKClarinet">
              <em class="citetitle">STKClarinet</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKDrummer.html" title="STKDrummer">
              <em class="citetitle">STKDrummer</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKFlute.html" title="STKFlute">
              <em class="citetitle">STKFlute</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKFMVoices.html" title="STKFMVoices">
              <em class="citetitle">STKFMVoices</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKHevyMetl.html" title="STKHevyMetl">
              <em class="citetitle">STKHevyMetl</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKMandolin.html" title="STKMandolin">
              <em class="citetitle">STKMandolin</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKModalBar.html" title="STKModalBar">
              <em class="citetitle">STKModalBar</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKMoog.html" title="STKMoog">
              <em class="citetitle">STKMoog</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKPercFlut.html" title="STKPercFlut">
              <em class="citetitle">STKPercFlut</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKPlucked.html" title="STKPlucked">
              <em class="citetitle">STKPlucked</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKResonate.html" title="STKResonate">
              <em class="citetitle">STKResonate</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKRhodey.html" title="STKRhodey">
              <em class="citetitle">STKRhodey</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKSaxofony.html" title="STKSaxofony">
              <em class="citetitle">STKSaxofony</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKShakers.html" title="STKShakers">
              <em class="citetitle">STKShakers</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKSimple.html" title="STKSimple">
              <em class="citetitle">STKSimple</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKSitar.html" title="STKSitar">
              <em class="citetitle">STKSitar</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKStifKarp.html" title="STKStifKarp">
              <em class="citetitle">STKStifKarp</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKTubeBell.html" title="STKTubeBell">
              <em class="citetitle">STKTubeBell</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKVoicForm.html" title="STKVoicForm">
              <em class="citetitle">STKVoicForm</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKWhistle.html" title="STKWhistle">
              <em class="citetitle">STKWhistle</em>
            </a>
          </li>
          <li class="listitem">
            <a class="link" href="STKWurley.html" title="STKWurley">
              <em class="citetitle">STKWurley</em>
            </a>
          </li>
        </ul>
      </div>
      <p>
  </p>
      <p>
    For more information about the STK opcodes, visit The Synthesis ToolKit in
    C++ (STK) web site at <a class="ulink" href="https://ccrma.stanford.edu/software/stk" target="_top">https://ccrma.stanford.edu/software/stk</a>.
  </p>
      <h2><a id="idp86975856"></a>Credits</h2>
      <p>
    This implementation of the STK unit generators was written by Perry R. Cook
    and Gary P. Scavone.
  </p>
      <p>
    The opcodes were further adapted as a plugin for Csound 5 by Michael Gogins.
  </p>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="ImageopcodesTop.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="PartOpcodesOverview.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="MiscopcodesTop.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">Image processing opcodes </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> Miscellaneous opcodes</td>
        </tr>
      </table>
    </div>
  </body>
</html>
